Management API

Base Resource URL:

     https://68.64.59.140/api/v01/customers/[customer-id]/subscriptions

Description:

Allows to manage the subscriptions associated with the specified customer.

Available sub-resources:

Resource URL Description
https://68.64.59.140/api/v01/customers/[customer-id]/subscriptions/[subscription-id]    Allows to manage the specified subscription.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  Subscription *      
Consumes:  json, xml  Produces:  json, xml 
 
Create subscription billing relationships by linking customers to payment plans for automated recurring charges. Enable predictable recurring revenue collection without the need to manage complex billing cycles.\n\r\n> **Note:** Each subscription requires an existing customer, payment plan, and associated payment method (card or bank account). The payment schedule is determined by the referenced payment plan configuration.\n\r\n> **Warning:** For Direct Debit (ACH) transactions, subscribe to NOC and return webhooks to receive real-time updates about bank account changes and failed transactions. Timely handling of these notifications prevents payment delays and reduces processing fees.\n\r\n> **Tip:** Use subscriptions for membership fees, recurring service charges, or any scheduled billing need. Our system automatically manages the billing cycle based on your payment plan parameters while retaining full control over the customer relationship.

Parameters:
# Name Type Required Default Description
01 object Subscription * Yes Information about the subscription transaction.

find  
Method:  GET       Implicit:  Yes       Returns:  Subscription[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns a list of available subscriptions.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned from the search result.\n\r\n> **Note:** Default value is 0. Used with limit parameter for pagination.\n\r\n> **Tip:** Use this field for implementing paginated results. See Error Messages section for details on pagination issues.
02 limit Integer No 100 Maximum number of records to load per search call.\n\r\n> **Note:** Default value is 100. Adjust based on performance requirements.\n\r\n> **Tip:** Use this field to balance response size and performance. See Webhooks Management Guide for details on handling large datasets.
03 billingCycleType String No Type of a Billing Cycle used for filtering Subscription records.
04 createDateFrom Date No The beginning date for filtering Subscription records; only records dated from this specific day onwards are included.
05 createDateTo Date No The concluding date for filtering Subscription records; only records up to and through this specified date are included.
06 lastBillingDateFrom Date No The beginning date of the last billing date range for filtering billing records; only records dated from this specified day onwards are included.
07 lastBillingDateTo Date No The concluding date of the last billing date range for filtering billing records; only records up to and through this specified date are included.
08 nextBillingDateFrom Date No The beginning date of the next billing date range for filtering upcoming billing records; only future records dated from this specified day onwards are included.
09 nextBillingDateTo Date No The concluding date of the next billing date range for filtering upcoming billing records; only future records up to and through this specified date are included.
10 amountFrom Integer No The lower amount limit for filtering Subscription records; only those with values at or above this specified amount are included.
11 amountTo Integer No The upper amount limit for filtering Subscription records; only those with values up to and through this specified amount are included.
12 planId Integer No Plan ID used for filtering Subscription records.
13 type String No Type of the Subscription used for filtering Subscription records.
14 status String No Status of the Subscription used for filtering Subscription records.
15 name String(255) No Name of the Subscription used for filtering Subscription records.

Copyright © Motionsoft. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.